/*
* The contents of this file are subject to the terms of the Common Development and
* Distribution License (the License). You may not use this file except in compliance with the
* License.
*
* You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
* specific language governing permission and limitations under the License.
*
* When distributing Covered Software, include this CDDL Header Notice in each file and include
* the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
* Header, with the fields enclosed by brackets [] replaced by your own identifying
* information: "Portions copyright [year] [name of copyright owner]".
*
* Copyright 2016 ForgeRock AS.
*/

package org.forgerock.openam.services.push;

/**
 * Interface to ensure that each delegate system can successfully convert a basic {@link PushMessage} into
 * one appropriate for putting on the wire.
 */
public interface PushMessageConverter {

    /**
     * Converts a supplied message and message id into an appropriately formatted (JSON) response
     * to drop into a message to Amazon SNS.
     *
     * @param message The message to write out to the user.
     * @return A String which has been formatted as JSON for putting on the wire.
     */
    String toTransferFormat(PushMessage message);

}
